/*
 * Copyright 2010 Biz-e (info@biz-e.nl)
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package nl.biz_e.appengine.lib.shared.login;

/**
 * A simple representation of a user.
 * 
 * @author Joost A. Bloemsma
 * 
 */
public interface IUser {
    /**
     * The id used for authentication.
     * 
     * @return The id.
     */
    public String getAuthenticationId();

    /**
     * @return The name of the user
     */
    public String getName();

    /**
     * The nickname of the user. If there is no special implementation of the
     * nickname, this method should return the same as {@link #getName()}.
     * 
     * @return The (Nick)name
     */
    public String getNickname();

    /**
     * @return true if this user is the result of a Google Login.
     */
    public boolean isGoogleLogin();
}
